home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dstevr.z / dstevr
Encoding:
Text File  |  2002-10-03  |  10.8 KB  |  265 lines
  1.  
  2.  
  3.  
  4. DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DSTEVR - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric tridiagonal matrix T
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DSTEVR( JOBZ, RANGE, N, D, E, VL, VU, IL, IU, ABSTOL, M, W, Z,
  14.                         LDZ, ISUPPZ, WORK, LWORK, IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, LIWORK, LWORK, M, N
  19.  
  20.          DOUBLE         PRECISION ABSTOL, VL, VU
  21.  
  22.          INTEGER        ISUPPZ( * ), IWORK( * )
  23.  
  24.          DOUBLE         PRECISION D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, *
  25.                         )
  26.  
  27. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  28.      These routines are part of the SCSL Scientific Library and can be loaded
  29.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  30.      directs the linker to use the multi-processor version of the library.
  31.  
  32.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  33.      4 bytes (32 bits). Another version of SCSL is available in which integers
  34.      are 8 bytes (64 bits).  This version allows the user access to larger
  35.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  36.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  37.      only one of the two versions; 4-byte integer and 8-byte integer library
  38.      calls cannot be mixed.
  39.  
  40. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  41.      DSTEVR computes selected eigenvalues and, optionally, eigenvectors of a
  42.      real symmetric tridiagonal matrix T. Eigenvalues and eigenvectors can be
  43.      selected by specifying either a range of values or a range of indices for
  44.      the desired eigenvalues.
  45.  
  46.      Whenever possible, DSTEVR calls SSTEGR to compute the
  47.      eigenspectrum using Relatively Robust Representations.  DSTEGR computes
  48.      eigenvalues by the dqds algorithm, while orthogonal eigenvectors are
  49.      computed from various "good" L D L^T representations (also known as
  50.      Relatively Robust Representations). Gram-Schmidt orthogonalization is
  51.      avoided as far as possible. More specifically, the various steps of the
  52.      algorithm are as follows. For the i-th unreduced block of T,
  53.         (a) Compute T - sigma_i = L_i D_i L_i^T, such that L_i D_i L_i^T
  54.              is a relatively robust representation,
  55.         (b) Compute the eigenvalues, lambda_j, of L_i D_i L_i^T to high
  56.             relative accuracy by the dqds algorithm,
  57.         (c) If there is a cluster of close eigenvalues, "choose" sigma_i
  58.             close to the cluster, and go to step (a),
  59.         (d) Given the approximate eigenvalue lambda_j of L_i D_i L_i^T,
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.             compute the corresponding eigenvector by forming a
  75.             rank-revealing twisted factorization.
  76.      The desired accuracy of the output can be specified by the input
  77.      parameter ABSTOL.
  78.  
  79.      For more details, see "A new O(n^2) algorithm for the symmetric
  80.      tridiagonal eigenvalue/eigenvector problem", by Inderjit Dhillon,
  81.      Computer Science Division Technical Report No. UCB//CSD-97-971, UC
  82.      Berkeley, May 1997.
  83.  
  84.  
  85.      Note 1 : DSTEVR calls SSTEGR when the full spectrum is requested on
  86.      machines which conform to the ieee-754 floating point standard.  DSTEVR
  87.      calls SSTEBZ and SSTEIN on non-ieee machines and
  88.      when partial spectrum requests are made.
  89.  
  90.      Normal execution of DSTEGR may create NaNs and infinities and hence may
  91.      abort due to a floating point exception in environments which do not
  92.      handle NaNs and infinities in the ieee standard default manner.
  93.  
  94.  
  95. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  96.      JOBZ    (input) CHARACTER*1
  97.              = 'N':  Compute eigenvalues only;
  98.              = 'V':  Compute eigenvalues and eigenvectors.
  99.  
  100.      RANGE   (input) CHARACTER*1
  101.              = 'A': all eigenvalues will be found.
  102.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  103.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  104.  
  105.      N       (input) INTEGER
  106.              The order of the matrix.  N >= 0.
  107.  
  108.      D       (input/output) DOUBLE PRECISION array, dimension (N)
  109.              On entry, the n diagonal elements of the tridiagonal matrix A.
  110.              On exit, D may be multiplied by a constant factor chosen to avoid
  111.              over/underflow in computing the eigenvalues.
  112.  
  113.      E       (input/output) DOUBLE PRECISION array, dimension (N)
  114.              On entry, the (n-1) subdiagonal elements of the tridiagonal
  115.              matrix A in elements 1 to N-1 of E; E(N) need not be set.  On
  116.              exit, E may be multiplied by a constant factor chosen to avoid
  117.              over/underflow in computing the eigenvalues.
  118.  
  119.      VL      (input) DOUBLE PRECISION
  120.              VU      (input) DOUBLE PRECISION If RANGE='V', the lower and
  121.              upper bounds of the interval to be searched for eigenvalues. VL <
  122.              VU.  Not referenced if RANGE = 'A' or 'I'.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      IL      (input) INTEGER
  141.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  142.              order) of the smallest and largest eigenvalues to be returned.  1
  143.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  144.              referenced if RANGE = 'A' or 'V'.
  145.  
  146.      ABSTOL  (input) DOUBLE PRECISION
  147.              The absolute error tolerance for the eigenvalues.  An approximate
  148.              eigenvalue is accepted as converged when it is determined to lie
  149.              in an interval [a,b] of width less than or equal to
  150.  
  151.              ABSTOL + EPS *   max( |a|,|b| ) ,
  152.  
  153.              where EPS is the machine precision.  If ABSTOL is less than or
  154.              equal to zero, then  EPS*|T|  will be used in its place, where
  155.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  156.              A to tridiagonal form.
  157.  
  158.              See "Computing Small Singular Values of Bidiagonal Matrices with
  159.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  160.              Working Note #3.
  161.  
  162.              If high relative accuracy is important, set ABSTOL to DLAMCH(
  163.              'Safe minimum' ).  Doing so will guarantee that eigenvalues are
  164.              computed to high relative accuracy when possible in future
  165.              releases.  The current code does not make any guarantees about
  166.              high relative accuracy, but future releases will. See J. Barlow
  167.              and J. Demmel, "Computing Accurate Eigensystems of Scaled
  168.              Diagonally Dominant Matrices", LAPACK Working Note #7, for a
  169.              discussion of which matrices define their eigenvalues to high
  170.              relative accuracy.
  171.  
  172.      M       (output) INTEGER
  173.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  174.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  175.  
  176.      W       (output) DOUBLE PRECISION array, dimension (N)
  177.              The first M elements contain the selected eigenvalues in
  178.              ascending order.
  179.  
  180.      Z       (output) DOUBLE PRECISION array, dimension (LDZ, max(1,M) )
  181.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  182.              the orthonormal eigenvectors of the matrix A corresponding to the
  183.              selected eigenvalues, with the i-th column of Z holding the
  184.              eigenvector associated with W(i).  Note: the user must ensure
  185.              that at least max(1,M) columns are supplied in the array Z; if
  186.              RANGE = 'V', the exact value of M is not known in advance and an
  187.              upper bound must be used.
  188.  
  189.      LDZ     (input) INTEGER
  190.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  191.              'V', LDZ >= max(1,N).
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      ISUPPZ  (output) INTEGER array, dimension ( 2*max(1,M) )
  207.              The support of the eigenvectors in Z, i.e., the indices
  208.              indicating the nonzero elements in Z. The i-th eigenvector is
  209.              nonzero only in elements ISUPPZ( 2*i-1 ) through ISUPPZ( 2*i ).
  210.  
  211.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  212.              On exit, if INFO = 0, WORK(1) returns the optimal (and minimal)
  213.              LWORK.
  214.  
  215.      LWORK   (input) INTEGER
  216.              The dimension of the array WORK.  LWORK >= 20*N.
  217.  
  218.              If LWORK = -1, then a workspace query is assumed; the routine
  219.              only calculates the optimal size of the WORK array, returns this
  220.              value as the first entry of the WORK array, and no error message
  221.              related to LWORK is issued by XERBLA.
  222.  
  223.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  224.              On exit, if INFO = 0, IWORK(1) returns the optimal (and minimal)
  225.              LIWORK.
  226.  
  227.      LIWORK  (input) INTEGER
  228.              The dimension of the array IWORK.  LIWORK >= 10*N.
  229.  
  230.              If LIWORK = -1, then a workspace query is assumed; the routine
  231.              only calculates the optimal size of the IWORK array, returns this
  232.              value as the first entry of the IWORK array, and no error message
  233.              related to LIWORK is issued by XERBLA.
  234.  
  235.      INFO    (output) INTEGER
  236.              = 0:  successful exit
  237.              < 0:  if INFO = -i, the i-th argument had an illegal value
  238.              > 0:  Internal error
  239.  
  240. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  241.      Based on contributions by
  242.         Inderjit Dhillon, IBM Almaden, USA
  243.         Osni Marques, LBNL/NERSC, USA
  244.         Ken Stanley, Computer Science Division, University of
  245.           California at Berkeley, USA
  246.  
  247.  
  248. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  249.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  250.  
  251.      This man page is available only online.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.